arrowKey

Type

message

Summary

Sent to the active control, or to the current card if no control is focused, when the user presses an arrow key.

Syntax

arrowKey <pKey>

Description

The parameter indicates which arrow key was pressed.

Handle the arrowKey message if you want to do something special when the user presses an arrow key.

If the arrowKey handler does not pass the message or send it to a further object in the message path, LiveCode does not perform the usual arrow key action (moving the insertion point, moving the selected object, or navigating to another card). Passing the message lets the arrow key action take place.

If the focused control is part of a group, and the group's tabGroupBehavior property is set to true, no arrowKey message is sent when the user presses an arrow key.

note

Sending an arrowKey message does nothing unless there is an arrowKey handler in the message path. This is a difference from HyperTalk's handling of the arrowKey message.

Parameters

Name	Type	Description
pKey	enum

Examples

on arrowKey theKey -- make Up arrow go to the first card
  if theKey is "up" then go to card 1
  else pass arrowKey
end arrowKey

Related

command: send

control structure: pass

glossary: property, current card, handler, focus, message path, pass, insertion point, message, HyperCard, active control, object

keyword: control

message: functionKey, selectionChanged

property: navigationArrows, textArrows, selected

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

Platforms

desktop

server